add deprecation warnings for lxd and libvirt related commands #4024

georgeliao · 2025-04-03T13:06:50Z

First, about the warning message, I reused the message from hyperkit. It alludes the migration we want to provide. Are we certain that we will offer a migration plan? Otherwise we need to tune warning message a bit.

For functional testing, only the following operations should trigger the warning message
multipass set local.driver=lxd/libvirt
multipass list, multipass launch, multipass info when the current driver is lxd or libvirt

codecov · 2025-04-03T13:20:44Z

Codecov Report

❌ Patch coverage is 38.88889% with 11 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.44%. Comparing base (b086fb7) to head (9c57114).
⚠️ Report is 405 commits behind head on main.

Files with missing lines	Patch %	Lines
src/utils/utils.cpp	0.00%	7 Missing ⚠️
src/daemon/daemon.cpp	66.66%	3 Missing ⚠️
src/client/cli/cmd/set.cpp	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4024      +/-   ##
==========================================
- Coverage   89.50%   89.44%   -0.07%     
==========================================
  Files         259      259              
  Lines       14740    14758      +18     
==========================================
+ Hits        13193    13200       +7     
- Misses       1547     1558      +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sharder996 · 2025-04-08T03:32:51Z

As far as I know, we will not be providing a programmatic way of migrating VMs through Multipass. It is possible that we a provide a guide for the user to still be able to access their VMs, but that still needs to be researched.

sharder996

A few things that still need to be tweaked, mostly docs stuff.

A few other thoughts, though:

I would like to see the changes in the docs put into a separate PR. Several reasons for this:

One, doc changes are instantaneous as in the user will see them right away, whereas code changes will only be visible in the next release (except for users on the edge channel).
Two, I think it would be good to have some input from a technical author on how to format a consistent deprecation warning. I'm not sure a find and replace is the best approach.
Three, there are still some code changes that need to happen and be reflected in the docs (i.e. CPU architecture support).

docs/explanation/driver.md

docs/how-to-guides/customise-multipass/set-up-the-driver.md

docs/how-to-guides/manage-instances/create-an-instance.md

docs/reference/settings/local-driver.md

include/multipass/constants.h

src/client/cli/cmd/set.cpp

georgeliao · 2025-04-08T10:17:32Z

I would like to see the changes in the docs put into a separate PR. Several reasons for this:

Moving the docs commits into another PR is good idea, will do.

Two, I think it would be good to have some input from a technical author on how to format a consistent deprecation warning. I'm not sure a find and replace is the best approach.

Not sure about how feasible it is to actually get a technical author review, but we can definitely refine on the current approach.

ricab · 2025-04-09T10:45:04Z

We'll need to offer an alternative in ARM architectures and replace LXD as default. Until then, we'd be issuing deprecation warnings to people who have no other option (fine in edge).

This means bringing QEMU in the snap for them too (hopefully only the right one for each architecture). Maybe better move it to vcpkg first?

All that can go in separate PRs, but I think it's necessary to complete the deprecation.

georgeliao · 2025-04-10T09:49:08Z

@sharder996 @ricab docs related comments are addressed in the docs PR. The comments of this PR are also addressed, feel free to have a final scan and we can start merging soon.

include/multipass/constants.h

sharder996

LGTM! Will be removed in a future PR so not too concerned about having it perfect.

ricab

Thanks Jia, this is what we need. I have some minor suggestions inline.

ricab · 2025-04-14T11:03:08Z

include/multipass/constants.h

+    "After the removal, you will find the guide on how to access the {0} instances on \n"
+    "https://documentation.ubuntu.com/multipass/en/latest/\n\n"; // TODO lxd and libvirt migration, remove


I like that we point to (future) documentation. However, maybe we could tune this to the driver and say:

for libvirt: "Your instances will remain available with the QEMU driver"

for LXD: "Your instances will no longer be available in Multipass then, but they will remain in LXD.

Then, when we actually remove the backend, we can say "... driver has been removed. Multipass is now using QEMU. ":

for libvirt: "Your instances remain available."

for LXD: "Your instances are still available in LXD. To access them, use lxc --project=multipass .... lxc --help for more.

Yes, I think that is better if we intend to let the user to access the lxd vm via lxd instead of offering a migration plan or guide.

tests/test_daemon.cpp

tests/test_daemon_launch.cpp

ricab

Hey @georgeliao, sorry I wasn't very clear. My idea was to actually come up with the appropriate message depending on which driver was selected, not print messages for both. Feel free to add different constants or derive the messages in some central part of the code if that is appropriate.

georgeliao · 2025-04-30T10:27:40Z

@ricab @sharder996 Maybe we can do another round of scan and finalize this?

ricab · 2025-04-23T16:16:49Z

src/utils/utils.cpp

    constexpr auto driver_deprecation_warning_template_common_part =
-        "**Warning! The {0} driver is deprecated and will be removed in an future "
-        "release.**\n\n";
+        "***Warning! The {0} driver is deprecated and will be removed in an future "


Still missing a space before/after the stars 😅

@georgeliao how about this one?

Did not notice that until you pointed out. Yes, the blueprint warning does have the space.

@ricab If there is no more comments. I think we can start to merge.

I would still like to take this for a spin Jia, and I am afraid I have no time today. I'll try to do that on Monday.

ricab · 2025-04-30T11:04:34Z

include/multipass/utils.h

 }

+std::string deprecation_warning_message_driver_concatenated(
+    const QString driver_name); // TODO lxd and libvirt migration, remove


There is no "migration" in this case, but we get the idea...

ricab

Hey Jia, almost there. I'd request only minor tweaks to messages.

src/client/cli/cmd/set.cpp

src/utils/utils.cpp

georgeliao · 2025-05-06T13:43:29Z

@ricab about the build, the Linux/Dispatch step is supposed to fail, right?

This reverts commit 3dcdf72.

… to de-duplicate the code.

Co-authored-by: ScottH <59572507+sharder996@users.noreply.github.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

…oof.

… accordingly.

Co-authored-by: Ricardo Abreu <ricardo.abreu@canonical.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

georgeliao marked this pull request as draft April 3, 2025 13:06

georgeliao changed the title ~~[daemon] added the lxd deprecation warning for multipass list command.~~ add deprecation warnings for lxd and libvirt related commands Apr 3, 2025

georgeliao force-pushed the lxd_libvirt_deprecation_warning branch 2 times, most recently from 8022cdc to 4208184 Compare April 4, 2025 20:47

georgeliao marked this pull request as ready for review April 7, 2025 08:13

georgeliao requested review from ricab and sharder996 April 7, 2025 08:15

georgeliao force-pushed the lxd_libvirt_deprecation_warning branch 2 times, most recently from 47088e4 to c01203b Compare April 7, 2025 08:41

georgeliao changed the title ~~add deprecation warnings for lxd and libvirt related commands~~ add deprecation warnings for lxd and libvirt related commands and documents Apr 7, 2025

sharder996 requested changes Apr 8, 2025

View reviewed changes

georgeliao force-pushed the lxd_libvirt_deprecation_warning branch from 8d5f9c1 to c01203b Compare April 8, 2025 10:23

georgeliao changed the title ~~add deprecation warnings for lxd and libvirt related commands and documents~~ add deprecation warnings for lxd and libvirt related commands Apr 8, 2025

georgeliao force-pushed the lxd_libvirt_deprecation_warning branch 3 times, most recently from 5d7809f to d8eebff Compare April 9, 2025 15:06

sharder996 requested changes Apr 10, 2025

View reviewed changes

include/multipass/constants.h Outdated Show resolved Hide resolved

include/multipass/constants.h Outdated Show resolved Hide resolved

sharder996 previously approved these changes Apr 11, 2025

View reviewed changes

ricab reviewed Apr 14, 2025

View reviewed changes

georgeliao dismissed sharder996’s stale review via 7319751 April 14, 2025 15:48

ricab requested changes Apr 14, 2025

View reviewed changes

ricab reviewed Apr 30, 2025

View reviewed changes

ricab requested changes May 6, 2025

View reviewed changes

src/client/cli/cmd/set.cpp Outdated Show resolved Hide resolved

src/utils/utils.cpp Outdated Show resolved Hide resolved

src/utils/utils.cpp Outdated Show resolved Hide resolved

georgeliao enabled auto-merge May 8, 2025 12:49

georgeliao and others added 22 commits May 9, 2025 17:34

[daemon] added the lxd deprecation warning for multipass list command.

f2ac024

[daemon] improve the template parameters name

9d5354c

[daemon] extended the warning to libvirt.

25d5a65

[daemon] added the deprecation warning to launch command.

200b974

[daemon] added warning message to find command.

b8e5958

[set] added the warning to setting the driver to lxd or libvirt

2e172b0

[daemon] added the warning message to the info command.

691f4df

Revert "[daemon] added warning message to find command."

e4fd637

This reverts commit 3dcdf72.

[daemon][set cmd] move the deprecation_warning_template central place…

6276dc7

… to de-duplicate the code.

[unit test] fix the linter.

2adbf60

[daemon] rename the warning message name.

2233847

[constants] refined the warning message for driver deprecation.

1644495

Update include/multipass/constants.h

b6ea000

Co-authored-by: ScottH <59572507+sharder996@users.noreply.github.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

[constants] improve the text based on review comments.

2958ee9

[constants] refined the warning message.

f0dff69

[unit test] changing return empty string to qemu string for future pr…

858be3c

…oof.

[daemon][set] recompose the deprecation message and refactor the code…

7b8f7ac

… accordingly.

[utils] polished the deprecation warning message.

5f4f5d4

[utils] added space between the * and the message.

728a754

Update src/client/cli/cmd/set.cpp

e55a34a

Co-authored-by: Ricardo Abreu <ricardo.abreu@canonical.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

Update src/utils/utils.cpp

4c44ff7

Co-authored-by: Ricardo Abreu <ricardo.abreu@canonical.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

Update src/utils/utils.cpp

9c57114

Co-authored-by: Ricardo Abreu <ricardo.abreu@canonical.com> Signed-off-by: George Liao <georgeliaojia@gmail.com>

georgeliao force-pushed the lxd_libvirt_deprecation_warning branch from 2093e0d to 9c57114 Compare May 9, 2025 15:35

georgeliao added this pull request to the merge queue May 9, 2025

Merged via the queue into main with commit d96227a May 9, 2025
17 of 19 checks passed

georgeliao deleted the lxd_libvirt_deprecation_warning branch May 9, 2025 22:25

ricab added this to the 1.16.0 milestone Jun 13, 2025

sharder996 mentioned this pull request Sep 29, 2025

Remove support for libvirt as multipass backend #4365

Merged

		"After the removal, you will find the guide on how to access the {0} instances on \n"
		"https://documentation.ubuntu.com/multipass/en/latest/\n\n"; // TODO lxd and libvirt migration, remove

add deprecation warnings for lxd and libvirt related commands #4024

add deprecation warnings for lxd and libvirt related commands #4024

Uh oh!

Conversation

georgeliao commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sharder996 commented Apr 8, 2025

Uh oh!

sharder996 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

georgeliao commented Apr 8, 2025

Uh oh!

ricab commented Apr 9, 2025

Uh oh!

georgeliao commented Apr 10, 2025

Uh oh!

Uh oh!

Uh oh!

sharder996 left a comment

Choose a reason for hiding this comment

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

ricab Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

georgeliao Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

georgeliao commented Apr 30, 2025

Uh oh!

ricab Apr 23, 2025

Choose a reason for hiding this comment

Uh oh!

ricab Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

georgeliao Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

georgeliao May 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ricab May 2, 2025

Choose a reason for hiding this comment

Uh oh!

ricab Apr 30, 2025

Choose a reason for hiding this comment

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

georgeliao commented May 6, 2025

Uh oh!

Uh oh!

georgeliao commented Apr 3, 2025 •

edited

Loading

codecov bot commented Apr 3, 2025 •

edited

Loading

georgeliao Apr 30, 2025 •

edited

Loading

georgeliao May 2, 2025 •

edited

Loading